Common Terms

Use the reference charts below to understand common terms used throughout the product and this document.

OneStream Client Application Terms

Term Definition
OneStream Windows Application client The Windows client facilitating user interface access for all user personas to OneStream applications.
OneStream Windows Application Server (App Server) The application server executing all OneStream business logic and processing.
Connection
(Gateway Connection, Direct Connection)
Connections define direct channels of integration between the OneStream Cloud and a local customer network. Connections are represented by a unique key and are configured for communication to an Azure Relay endpoint. Connections carry a 1:1 correlation to a local gateway on the SIC Local Gateway Server. The channel of communication is established from the OneStream connection and a local gateway is created in Smart Integration Connector Local Gateway Server.
Gateway Server A gateway server carries no unique technical definition or configuration address. It is a node in the tree control UI to organize connections and typically corresponds to an installed local gateway server name.
Custom Database Connections (System Configuration)
Custom database connections define a named data source to which OneStream may connect using Smart Integration Connector for the purpose of data import, data export, or drill through querying. The named custom database connection is referenced in OneStream business logic (data management objects or business rules) to initiate data source connectivity. Credentials and ancillary files required for a designated data source connection are configured to and reside on the corresponding local gateway server.
Direct Connection / Port Forwarding (e.g. SFTP, Web API) A direct connection represents a point-to-point channel to designated resources such as an SFTP server or Web API (including iPaaS services). The OneStream Local Gateway Server Configuration Utility UI facilitates configuration of mapped connections to resources where the on-premises TCP port is mapped to a server (hostname/IP).
Gateway Connection (e.g. DBs, DLL Integrations) A gateway connection represents the ultimate datasource destination for Smart Integration Connector, and is typically associated with a local gateway connection that connects to a designated database. The OneStream Local Gateway Server Configuration Utility facilitates configuration of required credentials and supporting files. The identification of a local gateway connection must correspond to a custom database connection established to the OneStream Application Server.
Smart Integration Function
(Remote Business Rule)
A Smart Integration Function (Remote Business Rule) is created in the Windows Desktop Client and compiled and executed on the local gateway server.
IPv4 Whitelist (Whitelisting)

Whitelisting can be applied to the Relay via IP addresses in the OneStream Windows Application client and also applied to your firewall via namespaces through your IT Admin.

OneStream Local Gateway Configuration Terms

Term Definition
Local Gateway Server Smart Integration Connector requires a client installation on Windows servers to establish a local gateway server. The local gateway server houses one or more local gateways which are configured through the OneStream Local Gateway Configuration.
Local Gateway Local gateways define the local customer endpoint for distinct channels of communication used by Smart Integration Connector. A local gateway facilitates connections to local databases, Web API connections, iPaaS servers, or SFTP servers and corresponds 1:1 with a gateway definition on the OneStream Application Server. To ensure a valid connection, a local gateway must be configured by importing the corresponding gateway definition exported from the OneStream Windows Application client.
Local Gateway Connections Local gateway connections are typically database connections defined in the utility and confirm the connection between the local gateway and the local data sources.
OneStream Local Gateway Configuration This utility is where you configure the local gateway server, local gateways and local gateway connections to data sources.